Skip to main content

MultiLanguageTextControl

A base input control that supports multi-language text entry and management, enabling localized content handling with event notifications for text changes.

Properties

NameDescription
ContextMenuColumnKeyThe key of the column associated with the context menu.
CaptionThe caption of the control.
LoadingIndicates whether the control is in a loading state.
MultiLanguageTextHolds the multi-language text content and manages localized text data for the control.
TextGets or sets the text content associated with the control.
ControlIdThe unique identifier of the control.
StyleThe styling properties for the control.
ClientEventsA list of client-side events associated with the control.
ReadOnlyGets or sets whether the control is read-only.
ContextMenuTargetThe target of the context menu.
RequiredGets or sets whether the control requires a value for validation.
DefaultReadOnlyGets or sets the default read-only state of the control.
TitleThe title of the control.
ShowCharacterCounterDetermines whether the character counter is displayed for the input field.
MaxLengthGets or sets the maximum number of characters allowed for the text input.
ExecutedServerEventsA list of server events that have been executed.
EntityPathGets or sets the data path used for binding this control to an entity.
NameThe name of the control.
ValueGets or sets the current value of the control. The type is defined by the generic parameter TValue.
EnableMultiLanguageTextIndicates whether multi-language text input is enabled.
VisibleIndicates whether the control is visible.
ClientVisibleIndicates whether the control is visible on the client side.
IndexableGets or sets whether the control's data is indexable for search and querying.
ServerEventsA list of server-side events associated with the control.
DefaultClientEnabledIndicates whether the control is enabled by default on the client side.
ClientReadOnlyGets or sets whether the control is read-only on the client side, regardless of server state.
ClientEnabledIndicates whether the control is enabled on the client side.
EnabledIndicates whether the control is enabled.
PlaceholderGets or sets the placeholder text for the control, supporting multiple languages.
ContextMenuKeyThe key associated with the context menu.
ContainerStyleThe styling properties for the container of the control.
TextAlignGets or sets the text alignment within the control.
IsSecretDataGets or sets a value indicating whether the text input should be treated as secret data (e.g., masked or encrypted).
CustomClassNameThe custom CSS class name applied to the control.
SizeGets or sets the layout size configuration for the control.
DefaultEnabledIndicates whether the control is enabled by default.
TabIndexGets or sets the tab order index for the control.

Constructors

NameDescription
BaseControl()Initializes a new instance of the MultiLanguageTextControl class with default values.
MultiLanguageTextControl()Initializes a new instance of the MultiLanguageTextControl class with default settings and binds text and multi-language events.
MultiLanguageTextControl()Initializes a new instance of the MultiLanguageTextControl class with default placeholder text and left-aligned text.
MultiLanguageTextControl()Initializes a new instance of the MultiLanguageTextControl class with empty event lists.
MultiLanguageTextControl()Initializes a new instance of the MultiLanguageTextControl class with default values for MaxLength and IsSecretData, and binds the DataLoad event.

Methods

NameDescription
ScrollTo()Scrolls to the control.
HideLoading()Removes the loading state from the control.
OnTextChanged(sender, e)Raises the TextChanged event after the text property has been updated.
FireClick()Triggers the Click event.
OnInit(sender, e)Raises the Init event.
GetDifferences(otherObj)Compares the current instance with another control and returns property differences, including placeholder and text alignment.
Hide()Hides the control.
OnPropertyValueGet(sender, e)Raises the PropertyValueGet event.
Show()Makes the control visible.
Equals(other)Determines whether the specified MultiLanguageTextControl is equal to the current control.
SetValueAsObject(value)Sets the internal multi-language text using a dictionary of language-text pairs.
OnMultiLanguageTextChanged(sender, e)Raises the MultiLanguageTextChanged event after the multi-language text has been changed.
OnDataLoad(sender, e)Raises the DataLoad event with the provided arguments.
OnRender(sender, e)Raises the Render event.
OnLoad(sender, e)Raises the Load event.
OnValueChanging(sender, e)Raises the ValueChanging event with the provided arguments and attaches metadata to the event output.
GetProtectedData(isDisabledOrReadOnly)#import (Bimser.CSP.FormControls.Base.ICanProtectData.GetProtectedData(bool)) (shortDescription)
RemoveText()Removes the current text content from the control.
ToggleLoading()Toggles the loading state of the control.
GetDifferences(otherObj)Compares the current instance with another control and returns the differences.
SetPropertyValue(mapping, value)Sets the value of a property specified by a mapping.
ClearDefaultValue()Clears the control’s default value. Can be overridden in derived classes.
LoadData(sender, e)Loads the given data into the control by assigning it to both the Text and Value properties.
OnValueChanged(sender, e)Raises the ValueChanged event with the provided arguments.
OnMultiLanguageTextChanging(sender, e)Raises the MultiLanguageTextChanging event before the multi-language text is changed.
OnPropertyChanged(sender, e)Handles the property changed event.
GetValueAsObject()Gets the current value of the control as a generic object. Override to return meaningful data in derived types.
ShowLoading()Sets the control to a loading state.
OnPreRender(sender, e)Raises the PreRender event.
GetDifferences(otherObj)Compares the current control with another and returns a dictionary of differences.
Equals(obj)Determines whether the specified object is equal to the current control.
OnValidating(sender, e)Raises the Validating event with the provided arguments.
OnTextChanging(sender, e)Raises the TextChanging event with the given arguments and attaches change metadata.
OnPropertyChanging(sender, e)Handles the property changing event.
SetText(text)Sets the text content of the control.
RemoveAll()Removes all editable content from the control.
OnDoubleClick(sender, e)Raises the DoubleClick event.
GetData()Gets the control’s current data, including type, text, and value, as a structured object.
IsValid()Returns a value indicating whether the control’s current value is valid.
OnClick(sender, e)Raises the Click event.
GetText()Returns the current text value of the control.
GetHashCode()Returns a hash code for the current control instance.

Events

NameDescription
ValidatingRaised before the control's value is validated.
InitTriggered when the control is initialized.
LoadTriggered when the control is loaded.
TextChangedRaised after the Text property has been changed.
ValueChangedRaised after the value of the control has changed.
DoubleClickTriggered when the control is double-clicked.
LazyLoadingRaised when the control initiates a lazy-loading operation to fetch additional data.
MultiLanguageTextChangedTriggered after the multi-language text has been changed.
PreRenderTriggered before the control is rendered.
PropertyValueGetTriggered when retrieving a control property value.
ClickTriggered when the control is clicked.
MultiLanguageTextChangingTriggered before the multi-language text is changed.
DataLoadRaised when external data is loaded into the control.
ValueChangingRaised before the value of the control is changed.
RenderTriggered when the control is rendered.
TextChangingRaised before the Text property is changed.

Generic Types

NameDescription
TValueRepresents the value type handled by the input control.
TEventValueRepresents the type used in value change events for the input control.